Skip to content

is_strict and is_fallible docs improvement - #9122

Merged
connortsui20 merged 1 commit into
developfrom
ct/scalar-fn-props-docs
Aug 4, 2026
Merged

is_strict and is_fallible docs improvement#9122
connortsui20 merged 1 commit into
developfrom
ct/scalar-fn-props-docs

Conversation

@connortsui20

Copy link
Copy Markdown
Member

Docs improvement to have better clarity and less verbosity

@connortsui20 connortsui20 added the changelog/docs A docs change label Jul 31, 2026
@connortsui20
connortsui20 enabled auto-merge (squash) July 31, 2026 15:46
Comment thread vortex-array/src/scalar_fn/vtable.rs Outdated
Comment on lines +197 to +198
/// A strict function returns null for a row when any argument is null for that row. This
/// matches PostgreSQL's `STRICT` convention for null propagation.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we link?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

best I can find is https://www.postgresql.org/docs/current/sql-createfunction.html and that description is honestly not great.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the docs I mean

Comment thread vortex-array/src/scalar_fn/vtable.rs Outdated
Comment thread vortex-array/src/scalar_fn/vtable.rs Outdated
Comment on lines +227 to +229
/// Returning `false` permits speculative evaluation. Dictionary push-down evaluates every
/// dictionary value, including values that no input row references. A fallible function could
/// therefore error on a value that normal evaluation (without pushdown) would never reach.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its not speculative

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this kind of how speculative execution works? We can apply the operation beforehand without knowing if it is used or not

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it

@joseph-isaacs
joseph-isaacs disabled auto-merge August 4, 2026 09:44
Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
@connortsui20
connortsui20 force-pushed the ct/scalar-fn-props-docs branch from 5806a43 to fa307f0 Compare August 4, 2026 19:23
@connortsui20
connortsui20 enabled auto-merge (squash) August 4, 2026 19:23
@codspeed-hq

codspeed-hq Bot commented Aug 4, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 10.94%

⚡ 1 improved benchmark
✅ 1841 untouched benchmarks
⏩ 44 skipped benchmarks1

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation compress_fsst[(1000, 64, 8)] 1.2 ms 1 ms +10.94%

Tip

Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.


Comparing ct/scalar-fn-props-docs (fa307f0) with develop (efa73f3)

Open in CodSpeed

Footnotes

  1. 44 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@connortsui20
connortsui20 merged commit 9b8bd8c into develop Aug 4, 2026
116 of 119 checks passed
@connortsui20
connortsui20 deleted the ct/scalar-fn-props-docs branch August 4, 2026 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/docs A docs change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants